=== !LogOut ===

[[PageOutline(3-4, Sections)]]

=== Intro ===

  logout user and end the session


=== Description ===

  '''struct !LogOut(string $token)'''

  This will logout user identified by token ''token''.
  This function should be called just before exiting/closing client application.


=== Parameters ===

  This function takes a single parameter of type ''string'':

  ''token''::
    token string identifying user's session, taken from [wiki:XmlRpcLogIn LogIn] result structure.


=== Return Values ===

  Output is returned in this structure: 
{{{
  struct(
    (string) [status],
    (double) [seconds]
  )
}}}

  and contains these elements:
    ''status''::
      function result code, see [XmlRpcStatusCode list of status codes]
    ''seconds''::
      time taken to execute this command on server


=== Implementations ===
  There are currently no available sample implementations.


=== Changelog ===

  Version 1: created this function

=== Examples ===


==== Input ====
  
{{{
#!xml
<methodCall>
 <methodName>LogOut</methodName>
 <params>
  <param>
   <value><string>5fdgt2e9qriblpbojnq0j46op1</string></value>
  </param>
 </params>
</methodCall>
}}}
  
  
==== Output ====
  
{{{
#!xml
<methodResponse>
 <params>
  <param>
   <value>
    <struct>
     <member>
      <name>status</name>
      <value><string>200 OK</string></value>
     </member>
     <member>
      <name>seconds</name>
      <value><double>0.197</double></value>
     </member>
    </struct>
   </value>
  </param>
 </params>
</methodResponse>
}}}


=== Notes ===

  none yet


=== See also ===

  * [wiki:XmlRpcLogIn LogIn]
  * [wiki:XmlRpcNoOperation NoOperation]


=== Comments ===

	add your comments, hints and suggestion here if you like ...


[wiki:XmlRpcLogIn Prev] [wiki:XmlRpcIntro Home] [Next]